home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / include / linux / usb / ch9.h < prev    next >
C/C++ Source or Header  |  2008-10-24  |  19KB  |  600 lines
  1. /*
  2.  * This file holds USB constants and structures that are needed for
  3.  * USB device APIs.  These are used by the USB device model, which is
  4.  * defined in chapter 9 of the USB 2.0 specification and in the
  5.  * Wireless USB 1.0 (spread around).  Linux has several APIs in C that
  6.  * need these:
  7.  *
  8.  * - the master/host side Linux-USB kernel driver API;
  9.  * - the "usbfs" user space API; and
  10.  * - the Linux "gadget" slave/device/peripheral side driver API.
  11.  *
  12.  * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems
  13.  * act either as a USB master/host or as a USB slave/device.  That means
  14.  * the master and slave side APIs benefit from working well together.
  15.  *
  16.  * There's also "Wireless USB", using low power short range radios for
  17.  * peripheral interconnection but otherwise building on the USB framework.
  18.  *
  19.  * Note all descriptors are declared '__attribute__((packed))' so that:
  20.  *
  21.  * [a] they never get padded, either internally (USB spec writers
  22.  *     probably handled that) or externally;
  23.  *
  24.  * [b] so that accessing bigger-than-a-bytes fields will never
  25.  *     generate bus errors on any platform, even when the location of
  26.  *     its descriptor inside a bundle isn't "naturally aligned", and
  27.  *
  28.  * [c] for consistency, removing all doubt even when it appears to
  29.  *     someone that the two other points are non-issues for that
  30.  *     particular descriptor type.
  31.  */
  32.  
  33. #ifndef __LINUX_USB_CH9_H
  34. #define __LINUX_USB_CH9_H
  35.  
  36. #include <linux/types.h>    /* __u8 etc */
  37.  
  38. /*-------------------------------------------------------------------------*/
  39.  
  40. /* CONTROL REQUEST SUPPORT */
  41.  
  42. /*
  43.  * USB directions
  44.  *
  45.  * This bit flag is used in endpoint descriptors' bEndpointAddress field.
  46.  * It's also one of three fields in control requests bRequestType.
  47.  */
  48. #define USB_DIR_OUT            0        /* to device */
  49. #define USB_DIR_IN            0x80        /* to host */
  50.  
  51. /*
  52.  * USB types, the second of three bRequestType fields
  53.  */
  54. #define USB_TYPE_MASK            (0x03 << 5)
  55. #define USB_TYPE_STANDARD        (0x00 << 5)
  56. #define USB_TYPE_CLASS            (0x01 << 5)
  57. #define USB_TYPE_VENDOR            (0x02 << 5)
  58. #define USB_TYPE_RESERVED        (0x03 << 5)
  59.  
  60. /*
  61.  * USB recipients, the third of three bRequestType fields
  62.  */
  63. #define USB_RECIP_MASK            0x1f
  64. #define USB_RECIP_DEVICE        0x00
  65. #define USB_RECIP_INTERFACE        0x01
  66. #define USB_RECIP_ENDPOINT        0x02
  67. #define USB_RECIP_OTHER            0x03
  68. /* From Wireless USB 1.0 */
  69. #define USB_RECIP_PORT            0x04
  70. #define USB_RECIP_RPIPE        0x05
  71.  
  72. /*
  73.  * Standard requests, for the bRequest field of a SETUP packet.
  74.  *
  75.  * These are qualified by the bRequestType field, so that for example
  76.  * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
  77.  * by a GET_STATUS request.
  78.  */
  79. #define USB_REQ_GET_STATUS        0x00
  80. #define USB_REQ_CLEAR_FEATURE        0x01
  81. #define USB_REQ_SET_FEATURE        0x03
  82. #define USB_REQ_SET_ADDRESS        0x05
  83. #define USB_REQ_GET_DESCRIPTOR        0x06
  84. #define USB_REQ_SET_DESCRIPTOR        0x07
  85. #define USB_REQ_GET_CONFIGURATION    0x08
  86. #define USB_REQ_SET_CONFIGURATION    0x09
  87. #define USB_REQ_GET_INTERFACE        0x0A
  88. #define USB_REQ_SET_INTERFACE        0x0B
  89. #define USB_REQ_SYNCH_FRAME        0x0C
  90.  
  91. #define USB_REQ_SET_ENCRYPTION        0x0D    /* Wireless USB */
  92. #define USB_REQ_GET_ENCRYPTION        0x0E
  93. #define USB_REQ_RPIPE_ABORT        0x0E
  94. #define USB_REQ_SET_HANDSHAKE        0x0F
  95. #define USB_REQ_RPIPE_RESET        0x0F
  96. #define USB_REQ_GET_HANDSHAKE        0x10
  97. #define USB_REQ_SET_CONNECTION        0x11
  98. #define USB_REQ_SET_SECURITY_DATA    0x12
  99. #define USB_REQ_GET_SECURITY_DATA    0x13
  100. #define USB_REQ_SET_WUSB_DATA        0x14
  101. #define USB_REQ_LOOPBACK_DATA_WRITE    0x15
  102. #define USB_REQ_LOOPBACK_DATA_READ    0x16
  103. #define USB_REQ_SET_INTERFACE_DS    0x17
  104.  
  105. /* The Link Power Mangement (LPM) ECN defines USB_REQ_TEST_AND_SET command,
  106.  * used by hubs to put ports into a new L1 suspend state, except that it
  107.  * forgot to define its number ...
  108.  */
  109.  
  110. /*
  111.  * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
  112.  * are read as a bit array returned by USB_REQ_GET_STATUS.  (So there
  113.  * are at most sixteen features of each type.)  Hubs may also support a
  114.  * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
  115.  */
  116. #define USB_DEVICE_SELF_POWERED        0    /* (read only) */
  117. #define USB_DEVICE_REMOTE_WAKEUP    1    /* dev may initiate wakeup */
  118. #define USB_DEVICE_TEST_MODE        2    /* (wired high speed only) */
  119. #define USB_DEVICE_BATTERY        2    /* (wireless) */
  120. #define USB_DEVICE_B_HNP_ENABLE        3    /* (otg) dev may initiate HNP */
  121. #define USB_DEVICE_WUSB_DEVICE        3    /* (wireless)*/
  122. #define USB_DEVICE_A_HNP_SUPPORT    4    /* (otg) RH port supports HNP */
  123. #define USB_DEVICE_A_ALT_HNP_SUPPORT    5    /* (otg) other RH port does */
  124. #define USB_DEVICE_DEBUG_MODE        6    /* (special devices only) */
  125.  
  126. #define USB_ENDPOINT_HALT        0    /* IN/OUT will STALL */
  127.  
  128.  
  129. /**
  130.  * struct usb_ctrlrequest - SETUP data for a USB device control request
  131.  * @bRequestType: matches the USB bmRequestType field
  132.  * @bRequest: matches the USB bRequest field
  133.  * @wValue: matches the USB wValue field (le16 byte order)
  134.  * @wIndex: matches the USB wIndex field (le16 byte order)
  135.  * @wLength: matches the USB wLength field (le16 byte order)
  136.  *
  137.  * This structure is used to send control requests to a USB device.  It matches
  138.  * the different fields of the USB 2.0 Spec section 9.3, table 9-2.  See the
  139.  * USB spec for a fuller description of the different fields, and what they are
  140.  * used for.
  141.  *
  142.  * Note that the driver for any interface can issue control requests.
  143.  * For most devices, interfaces don't coordinate with each other, so
  144.  * such requests may be made at any time.
  145.  */
  146. struct usb_ctrlrequest {
  147.     __u8 bRequestType;
  148.     __u8 bRequest;
  149.     __le16 wValue;
  150.     __le16 wIndex;
  151.     __le16 wLength;
  152. } __attribute__ ((packed));
  153.  
  154. /*-------------------------------------------------------------------------*/
  155.  
  156. /*
  157.  * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
  158.  * (rarely) accepted by SET_DESCRIPTOR.
  159.  *
  160.  * Note that all multi-byte values here are encoded in little endian
  161.  * byte order "on the wire".  But when exposed through Linux-USB APIs,
  162.  * they've been converted to cpu byte order.
  163.  */
  164.  
  165. /*
  166.  * Descriptor types ... USB 2.0 spec table 9.5
  167.  */
  168. #define USB_DT_DEVICE            0x01
  169. #define USB_DT_CONFIG            0x02
  170. #define USB_DT_STRING            0x03
  171. #define USB_DT_INTERFACE        0x04
  172. #define USB_DT_ENDPOINT            0x05
  173. #define USB_DT_DEVICE_QUALIFIER        0x06
  174. #define USB_DT_OTHER_SPEED_CONFIG    0x07
  175. #define USB_DT_INTERFACE_POWER        0x08
  176. /* these are from a minor usb 2.0 revision (ECN) */
  177. #define USB_DT_OTG            0x09
  178. #define USB_DT_DEBUG            0x0a
  179. #define USB_DT_INTERFACE_ASSOCIATION    0x0b
  180. /* these are from the Wireless USB spec */
  181. #define USB_DT_SECURITY            0x0c
  182. #define USB_DT_KEY            0x0d
  183. #define USB_DT_ENCRYPTION_TYPE        0x0e
  184. #define USB_DT_BOS            0x0f
  185. #define USB_DT_DEVICE_CAPABILITY    0x10
  186. #define USB_DT_WIRELESS_ENDPOINT_COMP    0x11
  187. #define USB_DT_WIRE_ADAPTER        0x21
  188. #define USB_DT_RPIPE            0x22
  189. #define USB_DT_CS_RADIO_CONTROL        0x23
  190.  
  191. /* Conventional codes for class-specific descriptors.  The convention is
  192.  * defined in the USB "Common Class" Spec (3.11).  Individual class specs
  193.  * are authoritative for their usage, not the "common class" writeup.
  194.  */
  195. #define USB_DT_CS_DEVICE        (USB_TYPE_CLASS | USB_DT_DEVICE)
  196. #define USB_DT_CS_CONFIG        (USB_TYPE_CLASS | USB_DT_CONFIG)
  197. #define USB_DT_CS_STRING        (USB_TYPE_CLASS | USB_DT_STRING)
  198. #define USB_DT_CS_INTERFACE        (USB_TYPE_CLASS | USB_DT_INTERFACE)
  199. #define USB_DT_CS_ENDPOINT        (USB_TYPE_CLASS | USB_DT_ENDPOINT)
  200.  
  201. /* All standard descriptors have these 2 fields at the beginning */
  202. struct usb_descriptor_header {
  203.     __u8  bLength;
  204.     __u8  bDescriptorType;
  205. } __attribute__ ((packed));
  206.  
  207.  
  208. /*-------------------------------------------------------------------------*/
  209.  
  210. /* USB_DT_DEVICE: Device descriptor */
  211. struct usb_device_descriptor {
  212.     __u8  bLength;
  213.     __u8  bDescriptorType;
  214.  
  215.     __le16 bcdUSB;
  216.     __u8  bDeviceClass;
  217.     __u8  bDeviceSubClass;
  218.     __u8  bDeviceProtocol;
  219.     __u8  bMaxPacketSize0;
  220.     __le16 idVendor;
  221.     __le16 idProduct;
  222.     __le16 bcdDevice;
  223.     __u8  iManufacturer;
  224.     __u8  iProduct;
  225.     __u8  iSerialNumber;
  226.     __u8  bNumConfigurations;
  227. } __attribute__ ((packed));
  228.  
  229. #define USB_DT_DEVICE_SIZE        18
  230.  
  231.  
  232. /*
  233.  * Device and/or Interface Class codes
  234.  * as found in bDeviceClass or bInterfaceClass
  235.  * and defined by www.usb.org documents
  236.  */
  237. #define USB_CLASS_PER_INTERFACE        0    /* for DeviceClass */
  238. #define USB_CLASS_AUDIO            1
  239. #define USB_CLASS_COMM            2
  240. #define USB_CLASS_HID            3
  241. #define USB_CLASS_PHYSICAL        5
  242. #define USB_CLASS_STILL_IMAGE        6
  243. #define USB_CLASS_PRINTER        7
  244. #define USB_CLASS_MASS_STORAGE        8
  245. #define USB_CLASS_HUB            9
  246. #define USB_CLASS_CDC_DATA        0x0a
  247. #define USB_CLASS_CSCID            0x0b    /* chip+ smart card */
  248. #define USB_CLASS_CONTENT_SEC        0x0d    /* content security */
  249. #define USB_CLASS_VIDEO            0x0e
  250. #define USB_CLASS_WIRELESS_CONTROLLER    0xe0
  251. #define USB_CLASS_MISC            0xef
  252. #define USB_CLASS_APP_SPEC        0xfe
  253. #define USB_CLASS_VENDOR_SPEC        0xff
  254.  
  255. /*-------------------------------------------------------------------------*/
  256.  
  257. /* USB_DT_CONFIG: Configuration descriptor information.
  258.  *
  259.  * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
  260.  * descriptor type is different.  Highspeed-capable devices can look
  261.  * different depending on what speed they're currently running.  Only
  262.  * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
  263.  * descriptors.
  264.  */
  265. struct usb_config_descriptor {
  266.     __u8  bLength;
  267.     __u8  bDescriptorType;
  268.  
  269.     __le16 wTotalLength;
  270.     __u8  bNumInterfaces;
  271.     __u8  bConfigurationValue;
  272.     __u8  iConfiguration;
  273.     __u8  bmAttributes;
  274.     __u8  bMaxPower;
  275. } __attribute__ ((packed));
  276.  
  277. #define USB_DT_CONFIG_SIZE        9
  278.  
  279. /* from config descriptor bmAttributes */
  280. #define USB_CONFIG_ATT_ONE        (1 << 7)    /* must be set */
  281. #define USB_CONFIG_ATT_SELFPOWER    (1 << 6)    /* self powered */
  282. #define USB_CONFIG_ATT_WAKEUP        (1 << 5)    /* can wakeup */
  283. #define USB_CONFIG_ATT_BATTERY        (1 << 4)    /* battery powered */
  284.  
  285. /*-------------------------------------------------------------------------*/
  286.  
  287. /* USB_DT_STRING: String descriptor */
  288. struct usb_string_descriptor {
  289.     __u8  bLength;
  290.     __u8  bDescriptorType;
  291.  
  292.     __le16 wData[1];        /* UTF-16LE encoded */
  293. } __attribute__ ((packed));
  294.  
  295. /* note that "string" zero is special, it holds language codes that
  296.  * the device supports, not Unicode characters.
  297.  */
  298.  
  299. /*-------------------------------------------------------------------------*/
  300.  
  301. /* USB_DT_INTERFACE: Interface descriptor */
  302. struct usb_interface_descriptor {
  303.     __u8  bLength;
  304.     __u8  bDescriptorType;
  305.  
  306.     __u8  bInterfaceNumber;
  307.     __u8  bAlternateSetting;
  308.     __u8  bNumEndpoints;
  309.     __u8  bInterfaceClass;
  310.     __u8  bInterfaceSubClass;
  311.     __u8  bInterfaceProtocol;
  312.     __u8  iInterface;
  313. } __attribute__ ((packed));
  314.  
  315. #define USB_DT_INTERFACE_SIZE        9
  316.  
  317. /*-------------------------------------------------------------------------*/
  318.  
  319. /* USB_DT_ENDPOINT: Endpoint descriptor */
  320. struct usb_endpoint_descriptor {
  321.     __u8  bLength;
  322.     __u8  bDescriptorType;
  323.  
  324.     __u8  bEndpointAddress;
  325.     __u8  bmAttributes;
  326.     __le16 wMaxPacketSize;
  327.     __u8  bInterval;
  328.  
  329.     /* NOTE:  these two are _only_ in audio endpoints. */
  330.     /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
  331.     __u8  bRefresh;
  332.     __u8  bSynchAddress;
  333. } __attribute__ ((packed));
  334.  
  335. #define USB_DT_ENDPOINT_SIZE        7
  336. #define USB_DT_ENDPOINT_AUDIO_SIZE    9    /* Audio extension */
  337.  
  338.  
  339. /*
  340.  * Endpoints
  341.  */
  342. #define USB_ENDPOINT_NUMBER_MASK    0x0f    /* in bEndpointAddress */
  343. #define USB_ENDPOINT_DIR_MASK        0x80
  344.  
  345. #define USB_ENDPOINT_XFERTYPE_MASK    0x03    /* in bmAttributes */
  346. #define USB_ENDPOINT_XFER_CONTROL    0
  347. #define USB_ENDPOINT_XFER_ISOC        1
  348. #define USB_ENDPOINT_XFER_BULK        2
  349. #define USB_ENDPOINT_XFER_INT        3
  350. #define USB_ENDPOINT_MAX_ADJUSTABLE    0x80
  351.  
  352.  
  353. /*-------------------------------------------------------------------------*/
  354.  
  355. /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
  356. struct usb_qualifier_descriptor {
  357.     __u8  bLength;
  358.     __u8  bDescriptorType;
  359.  
  360.     __le16 bcdUSB;
  361.     __u8  bDeviceClass;
  362.     __u8  bDeviceSubClass;
  363.     __u8  bDeviceProtocol;
  364.     __u8  bMaxPacketSize0;
  365.     __u8  bNumConfigurations;
  366.     __u8  bRESERVED;
  367. } __attribute__ ((packed));
  368.  
  369.  
  370. /*-------------------------------------------------------------------------*/
  371.  
  372. /* USB_DT_OTG (from OTG 1.0a supplement) */
  373. struct usb_otg_descriptor {
  374.     __u8  bLength;
  375.     __u8  bDescriptorType;
  376.  
  377.     __u8  bmAttributes;    /* support for HNP, SRP, etc */
  378. } __attribute__ ((packed));
  379.  
  380. /* from usb_otg_descriptor.bmAttributes */
  381. #define USB_OTG_SRP        (1 << 0)
  382. #define USB_OTG_HNP        (1 << 1)    /* swap host/device roles */
  383.  
  384. /*-------------------------------------------------------------------------*/
  385.  
  386. /* USB_DT_DEBUG:  for special highspeed devices, replacing serial console */
  387. struct usb_debug_descriptor {
  388.     __u8  bLength;
  389.     __u8  bDescriptorType;
  390.  
  391.     /* bulk endpoints with 8 byte maxpacket */
  392.     __u8  bDebugInEndpoint;
  393.     __u8  bDebugOutEndpoint;
  394. } __attribute__((packed));
  395.  
  396. /*-------------------------------------------------------------------------*/
  397.  
  398. /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
  399. struct usb_interface_assoc_descriptor {
  400.     __u8  bLength;
  401.     __u8  bDescriptorType;
  402.  
  403.     __u8  bFirstInterface;
  404.     __u8  bInterfaceCount;
  405.     __u8  bFunctionClass;
  406.     __u8  bFunctionSubClass;
  407.     __u8  bFunctionProtocol;
  408.     __u8  iFunction;
  409. } __attribute__ ((packed));
  410.  
  411.  
  412. /*-------------------------------------------------------------------------*/
  413.  
  414. /* USB_DT_SECURITY:  group of wireless security descriptors, including
  415.  * encryption types available for setting up a CC/association.
  416.  */
  417. struct usb_security_descriptor {
  418.     __u8  bLength;
  419.     __u8  bDescriptorType;
  420.  
  421.     __le16 wTotalLength;
  422.     __u8  bNumEncryptionTypes;
  423. } __attribute__((packed));
  424.  
  425. /*-------------------------------------------------------------------------*/
  426.  
  427. /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
  428.  * may be retrieved.
  429.  */
  430. struct usb_key_descriptor {
  431.     __u8  bLength;
  432.     __u8  bDescriptorType;
  433.  
  434.     __u8  tTKID[3];
  435.     __u8  bReserved;
  436.     __u8  bKeyData[0];
  437. } __attribute__((packed));
  438.  
  439. /*-------------------------------------------------------------------------*/
  440.  
  441. /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
  442. struct usb_encryption_descriptor {
  443.     __u8  bLength;
  444.     __u8  bDescriptorType;
  445.  
  446.     __u8  bEncryptionType;
  447. #define    USB_ENC_TYPE_UNSECURE        0
  448. #define    USB_ENC_TYPE_WIRED        1    /* non-wireless mode */
  449. #define    USB_ENC_TYPE_CCM_1        2    /* aes128/cbc session */
  450. #define    USB_ENC_TYPE_RSA_1        3    /* rsa3072/sha1 auth */
  451.     __u8  bEncryptionValue;        /* use in SET_ENCRYPTION */
  452.     __u8  bAuthKeyIndex;
  453. } __attribute__((packed));
  454.  
  455.  
  456. /*-------------------------------------------------------------------------*/
  457.  
  458. /* USB_DT_BOS:  group of device-level capabilities */
  459. struct usb_bos_descriptor {
  460.     __u8  bLength;
  461.     __u8  bDescriptorType;
  462.  
  463.     __le16 wTotalLength;
  464.     __u8  bNumDeviceCaps;
  465. } __attribute__((packed));
  466.  
  467. /*-------------------------------------------------------------------------*/
  468.  
  469. /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
  470. struct usb_dev_cap_header {
  471.     __u8  bLength;
  472.     __u8  bDescriptorType;
  473.     __u8  bDevCapabilityType;
  474. } __attribute__((packed));
  475.  
  476. #define    USB_CAP_TYPE_WIRELESS_USB    1
  477.  
  478. struct usb_wireless_cap_descriptor {    /* Ultra Wide Band */
  479.     __u8  bLength;
  480.     __u8  bDescriptorType;
  481.     __u8  bDevCapabilityType;
  482.  
  483.     __u8  bmAttributes;
  484. #define    USB_WIRELESS_P2P_DRD        (1 << 1)
  485. #define    USB_WIRELESS_BEACON_MASK    (3 << 2)
  486. #define    USB_WIRELESS_BEACON_SELF    (1 << 2)
  487. #define    USB_WIRELESS_BEACON_DIRECTED    (2 << 2)
  488. #define    USB_WIRELESS_BEACON_NONE    (3 << 2)
  489.     __le16 wPHYRates;    /* bit rates, Mbps */
  490. #define    USB_WIRELESS_PHY_53        (1 << 0)    /* always set */
  491. #define    USB_WIRELESS_PHY_80        (1 << 1)
  492. #define    USB_WIRELESS_PHY_107        (1 << 2)    /* always set */
  493. #define    USB_WIRELESS_PHY_160        (1 << 3)
  494. #define    USB_WIRELESS_PHY_200        (1 << 4)    /* always set */
  495. #define    USB_WIRELESS_PHY_320        (1 << 5)
  496. #define    USB_WIRELESS_PHY_400        (1 << 6)
  497. #define    USB_WIRELESS_PHY_480        (1 << 7)
  498.     __u8  bmTFITXPowerInfo;    /* TFI power levels */
  499.     __u8  bmFFITXPowerInfo;    /* FFI power levels */
  500.     __le16 bmBandGroup;
  501.     __u8  bReserved;
  502. } __attribute__((packed));
  503.  
  504. #define    USB_CAP_TYPE_EXT        2
  505.  
  506. struct usb_ext_cap_descriptor {        /* Link Power Management */
  507.     __u8  bLength;
  508.     __u8  bDescriptorType;
  509.     __u8  bDevCapabilityType;
  510.     __u8  bmAttributes;
  511. #define USB_LPM_SUPPORT            (1 << 1)    /* supports LPM */
  512. } __attribute__((packed));
  513.  
  514. /*-------------------------------------------------------------------------*/
  515.  
  516. /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
  517.  * each endpoint descriptor for a wireless device
  518.  */
  519. struct usb_wireless_ep_comp_descriptor {
  520.     __u8  bLength;
  521.     __u8  bDescriptorType;
  522.  
  523.     __u8  bMaxBurst;
  524.     __u8  bMaxSequence;
  525.     __le16 wMaxStreamDelay;
  526.     __le16 wOverTheAirPacketSize;
  527.     __u8  bOverTheAirInterval;
  528.     __u8  bmCompAttributes;
  529. #define USB_ENDPOINT_SWITCH_MASK    0x03    /* in bmCompAttributes */
  530. #define USB_ENDPOINT_SWITCH_NO        0
  531. #define USB_ENDPOINT_SWITCH_SWITCH    1
  532. #define USB_ENDPOINT_SWITCH_SCALE    2
  533. } __attribute__((packed));
  534.  
  535. /*-------------------------------------------------------------------------*/
  536.  
  537. /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
  538.  * host and a device for connection set up, mutual authentication, and
  539.  * exchanging short lived session keys.  The handshake depends on a CC.
  540.  */
  541. struct usb_handshake {
  542.     __u8 bMessageNumber;
  543.     __u8 bStatus;
  544.     __u8 tTKID[3];
  545.     __u8 bReserved;
  546.     __u8 CDID[16];
  547.     __u8 nonce[16];
  548.     __u8 MIC[8];
  549. } __attribute__((packed));
  550.  
  551. /*-------------------------------------------------------------------------*/
  552.  
  553. /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
  554.  * A CC may also be set up using non-wireless secure channels (including
  555.  * wired USB!), and some devices may support CCs with multiple hosts.
  556.  */
  557. struct usb_connection_context {
  558.     __u8 CHID[16];        /* persistent host id */
  559.     __u8 CDID[16];        /* device id (unique w/in host context) */
  560.     __u8 CK[16];        /* connection key */
  561. } __attribute__((packed));
  562.  
  563. /*-------------------------------------------------------------------------*/
  564.  
  565. /* USB 2.0 defines three speeds, here's how Linux identifies them */
  566.  
  567. enum usb_device_speed {
  568.     USB_SPEED_UNKNOWN = 0,            /* enumerating */
  569.     USB_SPEED_LOW, USB_SPEED_FULL,        /* usb 1.1 */
  570.     USB_SPEED_HIGH,                /* usb 2.0 */
  571.     USB_SPEED_VARIABLE,            /* wireless (usb 2.5) */
  572. };
  573.  
  574. enum usb_device_state {
  575.     /* NOTATTACHED isn't in the USB spec, and this state acts
  576.      * the same as ATTACHED ... but it's clearer this way.
  577.      */
  578.     USB_STATE_NOTATTACHED = 0,
  579.  
  580.     /* chapter 9 and authentication (wireless) device states */
  581.     USB_STATE_ATTACHED,
  582.     USB_STATE_POWERED,            /* wired */
  583.     USB_STATE_UNAUTHENTICATED,        /* auth */
  584.     USB_STATE_RECONNECTING,            /* auth */
  585.     USB_STATE_DEFAULT,            /* limited function */
  586.     USB_STATE_ADDRESS,
  587.     USB_STATE_CONFIGURED,            /* most functions */
  588.  
  589.     USB_STATE_SUSPENDED
  590.  
  591.     /* NOTE:  there are actually four different SUSPENDED
  592.      * states, returning to POWERED, DEFAULT, ADDRESS, or
  593.      * CONFIGURED respectively when SOF tokens flow again.
  594.      * At this level there's no difference between L1 and L2
  595.      * suspend states.  (L2 being original USB 1.1 suspend.)
  596.      */
  597. };
  598.  
  599. #endif /* __LINUX_USB_CH9_H */
  600.